home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / BROWSERS / FRACIRC / FRACIRC.DOC < prev    next >
Encoding:
Text File  |  1997-01-21  |  11.2 KB  |  266 lines
  1.     
  2.     
  3.               ###########
  4.               ###########
  5.               ####                         || ||||||   |||||
  6.               ####     ####   ####   ####  || ||   || ||
  7.               #######  ## ## ##  ## #####  || ||   || ||
  8.               #######  ####  ###### ##     || ||||||  ||
  9.               ####     ## ## ##  ## #####  || ||   || ||
  10.               ####     ##  ## #  ##  ####  || ||   || ||
  11.               ####                         || ||   ||  |||||
  12.               
  13.         *** Version 1.09, released on the 21st December, 1996 ***
  14.         
  15.  
  16. ***** For upgraders from V1.00 or V1.01 *****
  17. Please make sure to completely reinstall this
  18. package and not to use any old DEFAULT.DAT 
  19. files. The program now looks for FRACIRC.DAT
  20. and the contents has changed dramatically.
  21.  
  22.                          <<< Documentation >>>
  23.  
  24.     This program is Shareware, and may be freely distributed (provided 
  25. it is kept intact within the original, unaltered, zip file). If however 
  26. you decide you find it useful, a contribution to make my efforts 
  27. worthwhile will be appreciated. Please find details at the end of this 
  28. document. 
  29.                              
  30.  Table of contents
  31.  =================
  32.  
  33.  1. Introduction/history
  34.  
  35.  2. Setting up Fracirc
  36.  
  37.  3. Getting connected
  38.  
  39.  4. Use online
  40.  
  41.  5. DCC file transfers
  42.  
  43.  6. Future versions
  44.  
  45.  7. Support/registration details
  46.  
  47.  
  48. ------------------------------------------------------------------------
  49.  
  50.  
  51.  
  52.     1. Introduction
  53.     ===============
  54.     
  55.     It is about 10 months since I got my first demon internet account, 
  56. and logged on for the very first time, using Oasis 1.35. Everything 
  57. worked, and I eventually found my way to #atari on IRCnet. There the main 
  58. buzz was something called STiK which I had seen given away on a previous 
  59. STF (sob!) cover disk. I loaded all this up and got online with that, 
  60. deciding that this was something I much preferred.
  61.  
  62.     IRC soon became my favourite net pastime. The only software for 
  63. STiK back then however was a small kludged TOS program by Steve Adams 
  64. (worship due). I had just bought Lattice C and was eager for something to 
  65. try. Here, surely was the perfect opportunity. For the first time I could 
  66. identify something which nobody else had yet done. A fully GEMed IRC client 
  67. for use with STiK.
  68.     In hindsight, an IRC client is /not/ the thing to use as your 
  69. first C project :). However I think I've battled over most of the problems 
  70. on the way. Some time later (ok, I'm lazy <g>) I think I've finally got 
  71. the program to a point where people might find it useful. Provided I have 
  72. a positive response from this first release (I hope there aren't /too/ 
  73. many bugs!) then I will continue to develop this program.
  74.  
  75.  
  76.  
  77. ------------------------------------------------------------------------
  78.  
  79.     2. Setting up Fracirc
  80.     =====================
  81.     
  82.  
  83.     When you received Fracirc it should have arrived in ZIP format. 
  84. Having unzipped it, its a good idea to make sure all the files are in the 
  85. same folder. Call it FRACIRC or something (why not?!).
  86.     Your directory should then look like this:
  87.     
  88.         \FRACIRC\DOWNLOAD\    - A download folder for use with DCC
  89.         \FRACIRC\FRACIRC.PRG  - The main program file
  90.         \FRACIRC\FRACIRC.RSC  - The RSC file
  91.         \FRACIRC\FRACIRC.DAT  - A default setup file
  92.         \FRACIRC\FRACIRC.DOC  - This document
  93.         \FRACIRC\COMMANDS.TXT - A list of commands implemented
  94.                         in this version of Fracirc.
  95.         \FRACIRC\NEW.TXT      - New features in this version.
  96.         \FRACIRC\PLANNED.TXT  - Whats coming?
  97.         \FRACIRC\FRACIRC.DAT  - Macro file
  98.         
  99.     When you have made sure that this is your setup, double click on 
  100. FRACIRC.PRG to run the program. You will be presented with a plain window, 
  101. and a menu bar, just like a normal GEM program (thats because it is!). 
  102. Upon running, Fracirc will always try to load the setup file called 
  103. DEFAULT.DAT in the same directory as the program. If this does not exist, 
  104. or if it is the original one from the zip file, you will now want to 
  105. configure Fracirc to your tastes. Go progressively down the Options menu 
  106. in order to make the necessary changes. If you are unfamiliar with IRC 
  107. then here is a quick rundown of what it all means :
  108.  
  109. Server settings :
  110.  
  111.     IRC Server - Here put the server you are going to be using. 
  112. Usually one will have been suggested by your Internet Service Provider. If 
  113. not a sample one to try is irc.demon.co.uk
  114.  
  115.     IRC Port - Every server has different ports to connect to. If you 
  116. have the name of the server a port will almost certainly have been 
  117. specified too. If not, then use 6667 with irc.demon.co.uk.
  118.  
  119. User settings :
  120.     
  121.     Alias - Everyone goes under another name on IRC. Here put what you 
  122. want to be called (no spaces).
  123.     Username - Reconfigure the defaults if you're not sure.
  124.     Realname -      "       "     "      "    "     "   "
  125.     Hostname -      "       "     "      "    "     "   "
  126.  
  127.  
  128. Path settings :
  129.  
  130.     DCC Receive - This is the path where DCC files will be received 
  131. to. If you cannot remember, or are too lazy to type, the path you wish to 
  132. use, then click on the box. This will bring up a file selector. The path 
  133. should be specified including a trailing \.
  134.  
  135. Colour settings :
  136.  
  137.     In each of these various boxes, enter the colour number to specify 
  138. what colour you wish the described things to come under. The set of 
  139. coloured boxes above the the form indicate the number:colour.
  140.  
  141.  
  142.     When all the above is to your satisfaction, go to the File menu, 
  143. select Save Setup. If you wish this setup to be loaded everytime you run 
  144. Fracirc then save it as DEFAULT.DAT in the same directory. Otherwise just 
  145. save the file as whatever you want. To get the setup back you will have to 
  146. use Load Setup from the same menu.
  147.  
  148.  
  149. ----------------------------------------------------------------------
  150.  
  151.     3. Getting connected
  152.     ====================
  153.     
  154.     You should have already got STiK setup in order to run Fracirc. If 
  155. you do not, its beyond the scope of this documentation to tell you how. 
  156. Refer elsewhere for help on this.
  157.  
  158.     Connect with STiK and select Connect from the Remote menu. Here 
  159. there will be three boxes. Irc Server, Port, and alias. These relate to 
  160. those options you entered previously in the options menu. If you wish to 
  161. temporarily change these for one connection, then alter them here. 
  162. Everytime you reconnect, they will default back to your original settings.
  163. Select Okay to start the connection process. If the connection fails the 
  164. reason should be reported to you. If you wish to abort at any stage then 
  165. the Escape key will work. The Message Of The Day of the 
  166. server that you have connected to should scroll up the screen, and you're 
  167. in.
  168.  
  169. -----------------------------------------------------------------------
  170.  
  171.     4. Use Online
  172.     =============
  173.     
  174.     For details of IRC commands you can utilise please refer to the 
  175. file COMMANDS.TXT included in this archive.
  176.  
  177.     To connect to a channel go to the channel (!!) menu and select 
  178. open a channel. You will be presented with a dialogue in which you enter 
  179. the name of the channel (preceded by a # still). Unlike a lot of IRC 
  180. clients, Fracirc will not become confused if you fail to connect to the 
  181. channel. It will only register a connection upon confirmation from the 
  182. server.
  183.     When you have connected to the channel the channel name will 
  184. appear as the title of the current window. The info line displays details 
  185. of your current alias, and the current channel.
  186.     Fracirc allows a maximum of ten channels to be opened at once (if 
  187. anyone finds a need for more, then mail me!). It also allows a maximum of 
  188. six windows open (provided the system has that many free). In any window 
  189. you can have up to ten channels, or any combination over different 
  190. windows.
  191.     To cycle channels, either use the menu option or use the shortcut 
  192. [HELP]. This option will cycle through all the channels open, topping 
  193. different windows if necessary. You can also cycle windows, using the menu 
  194. option or the shortcut [UNDO]. I think this gives you the easiest 
  195. navigation possible through the program. If you can think of a better way 
  196. of doing it, I'll be very interested to hear!
  197.     Upon completion of your IRCing, use the the connect menu option 
  198. "Disconnect", CTRL-Q, or the command "/quit".
  199.  
  200. ------------------------------------------------------------------------
  201.  
  202.     5. DCC file transfers
  203.     =====================
  204.  
  205.     Fracirc has a maximum of ten DCC channels, each of which can 
  206. either be sending or receiving a file.
  207.  
  208.     When someone sends you a file, an alert box will confirm with you 
  209. whether you wish to receive that file or not. Clicking "Accept" will 
  210. initiate the file transfer. All DCC file transfer information is updated 
  211. in a window of its own (titled "DCC File Transfers"). If this is not 
  212. already open it will be opened, and relevant information henceforth sent 
  213. to there.
  214.     If you wish to send a file, go to the DCC menu, and select 
  215. Initiate send. You will then get a dialogue box in which you must enter 
  216. the name and path of the file you wish to send. If you click on the box 
  217. you will be presented with a file selector to make it easier. Click on 
  218. Okay and the file will be sent (once more information going to the DCC 
  219. window).
  220.     To view the current DCC transfers use the command "/dcc" and you 
  221. will be given a detailed list. If at any point you wish to abort any 
  222. outstanding transfers then use the command "/reset" and all DCC channels 
  223. will be reset.
  224.  
  225. -----------------------------------------------------------------------
  226.  
  227.     6. Future versions
  228.     ==================
  229.     
  230.     Please see PLANNED.TXT for some of the features coming up.
  231.     
  232. ------------------------------------------------------------------------
  233.  
  234.      7. Support/Registration
  235.      =======================
  236.      
  237.      I hope you will find that even at this version, Fracirc has 
  238. something to offer you. Never before on the atari has there been such a 
  239. useable IRC client. Multitasking is not a problem as far as I know. It 
  240. works perfectly with magic although I have had one or two difficulties 
  241. with Geneva. If you find you like this program, and are hoping that I'm 
  242. going to add the facilities mentioned in the previous section, then a 
  243. small shareware contribution would be appreciated. This helps to show me 
  244. not only that you have an interest in my program, but also the care and 
  245. need for such a program. A £5-£10 registration fee is suggested, although 
  246. further contributions are welcome. I have not crippled this version in 
  247. any way (it may not be the same in future) but if you register you will 
  248. get:     Your own slightly personalised copy.
  249.     An immediate update with future versions (minus cripples).
  250.     
  251.     Please send postal orders/cheques made payable to Tim Putnam to 
  252. the following address:
  253.     Tim Putnam (Fracirc),     1 Mill Lane, Stratton, Dorchester, Dorset, 
  254.                 DT2 9RX.
  255.     When posting, please include details of your home address, 
  256. telephone number, email address and computer setup so I can supply you 
  257. with further upgrades and have an idea about who my user group is.
  258.                 
  259.     If you have any problems or comments about this program, I can be 
  260. contacted at the email address : Timpy@roseivy.demon.co.uk, or am often to 
  261. be found on #atari under the alias Fraccy.
  262.  
  263. Good luck!
  264. -------------------------------------------------------------------------
  265.      
  266.